istextorbinary

What is istextorbinary?

The istextorbinary npm package is used to determine whether a given file or buffer is text or binary. This can be useful in various scenarios such as file processing, content validation, and data handling.

What are istextorbinary's main functionalities?

Check if a file is text or binary

This feature allows you to check if a file is text or binary. The `isText` function takes a file path and a callback function. The callback function receives an error (if any) and a boolean indicating whether the file is text.

const istextorbinary = require('istextorbinary');

istextorbinary.isText('example.txt', function(err, result) {
  if (err) throw err;
  console.log(result ? 'Text' : 'Binary');
});

Check if a buffer is text or binary

This feature allows you to check if a buffer is text or binary. The `isText` function can also take a buffer as an argument. The callback function receives an error (if any) and a boolean indicating whether the buffer is text.

const istextorbinary = require('istextorbinary');

const buffer = Buffer.from('Hello, world!');
istextorbinary.isText(null, buffer, function(err, result) {
  if (err) throw err;
  console.log(result ? 'Text' : 'Binary');
});

Synchronous check if a file is text or binary

This feature allows you to synchronously check if a file is text or binary. The `isTextSync` function takes a file path and returns a boolean indicating whether the file is text.

const istextorbinary = require('istextorbinary');

const result = istextorbinary.isTextSync('example.txt');
console.log(result ? 'Text' : 'Binary');

Synchronous check if a buffer is text or binary

This feature allows you to synchronously check if a buffer is text or binary. The `isTextSync` function can also take a buffer as an argument and returns a boolean indicating whether the buffer is text.

const istextorbinary = require('istextorbinary');

const buffer = Buffer.from('Hello, world!');
const result = istextorbinary.isTextSync(null, buffer);
console.log(result ? 'Text' : 'Binary');

Other packages similar to istextorbinary

file-type

The file-type package is used to detect the file type of a Buffer/Uint8Array/ArrayBuffer. It can determine the MIME type and extension of a file. Unlike istextorbinary, which focuses on distinguishing between text and binary, file-type provides more detailed information about the file type.

detect-file-type

The detect-file-type package is another library for detecting the file type of a buffer or stream. It provides similar functionality to file-type but with a different API. It can identify a wide range of file types, whereas istextorbinary is specifically designed to differentiate between text and binary files.

binary-parser

The binary-parser package is used for parsing binary data in Node.js. It allows you to define a schema for binary data and parse it accordingly. While it doesn't directly compete with istextorbinary, it is useful for working with binary data once you have identified it using istextorbinary.

README

Is Text or Binary?

Determines if a buffer is comprised of text or binary

Install

NPM

• Use: require('istextorbinary')
• Install: npm install --save istextorbinary

Usage

// Sync
var result = require('istextorbinary').isTextSync(filename, buffer);

// Async
require('istextorbinary').isText(filename, buffer, function(err, result){
	// ...
});

// You can supply text or buffer, or both text and buffer, the more provided, the more accurate the result
// isBinary, and isBinarySync methods also provided

History

Discover the change history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton [e-mail] (https://github.com/balupton)

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton [e-mail] — view contributions
• shinnn — view contributions

Become a contributor!

License

Licensed under the incredibly permissive MIT license

Copyright © 2012+ Bevry Pty Ltd [e-mail] (http://bevry.me)
Copyright © 2011 Benjamin Lupton [e-mail] (http://balupton.com)

Changelog

v1.0.2 2015 January 16

• Fixed build
• Added test for text files